Return

Edit Task: NonRecurringPeriodicWindows

Description

The NonRecurringPeriodicWindows attribute under EditTask defines a user-set amount of periodic windows for the task. This attribute may only be used if the RecurringType attribute is set to SingleInstance. Overlapping availabilities are merged into a single availability with the earliest start time and latest stop time for non-recurring periodic windows. Any previous periodic windows are deleted. For more information on parameters, see the description of the Periodic Window Definition Form.

Parameters

Parameter	Description
Frequency	Frequency options should be entered on their own and the options are as follows: "Yearly", "Monthly", "Weekly", "Daily", "Hourly", "Minutely", "Custom"
Start	The format is "YYYY/MM/DD_HH:MM:SS" or "YYYY/MM/DD_HH:MM:SS.fff" .
Stop	The format is "YYYY/MM/DD_HH:MM:SS" or "YYYY/MM/DD_HH:MM:SS.fff" .
CustomEpoch	Epoch time is only used if the frequency option is "Custom", otherwise the parameter should not be included in the command. The parameter should be on its own and in the format -- "YYY/MM/DD__HH:MM:SS" or "YYYY/MM/DD_HH:MM:SS.fff".
CustomInterval	Interval is only used if the frequency option is "Custom", otherwise the parameter should not be included in the command. The parameter should be on its own and entered in numeric second(millisecond fidelity).
Period Comment	A string of text of the comment itself in single quotes. May be an empty string if no comment is desired.
"Internal Windows" : "Offset"	The parameter value format is based on the format of the frequency: Yearly: MM/DD_HH:MM:SS.fff (e.g. 11/12_10:04:05.100) Monthly: DD_HH:MM:SS.fff (e.g. 12_10:04:05.100) Weekly: DD_HH:MM:SS.fff (e.g. TU_10:04:05.100) Daily: HH:MM:SS.fff (e.g. 10:04:05.100) Hourly: MM:SS.fff (e.g. 04:05.100) Minutely: SS.fff (e.g. 05.100) Can also be a number in seconds (millisecond fidelity). The offset is always anchored at the top of the windows frequency. For example, an offset of 1 hour for a daily recurrence would be 1:00:00 of that day. The start of the period has no effect on the offset other than for custom definitions.
"Internal Windows" : "Duration"	Enter as a number in seconds (millisecond fidelity).
"Internal Windows" : "Comment"	A string of text in single quotes of the comment for the given inside window.

Examples

Set a yearly non-recurring window that occurs every Jan 1, with a duration of 1000 seconds

PATCH api/task/TaskA

Body:

{

"NonRecurringPeriodicWindows" : {

"Frequency" : "Yearly",

"Start" : "2015/01/01_09:30:00",

"Stop" : "2015/01/03_00:00:00",

"Internal Windows" : {

"Offset" : "01/01_00:30:00"

"Duration" : "1000"

"Comment" : "NonRecurring Yearly" }

}